home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / pcb / cscls120.zip / CSCALLS.DOC < prev    next >
Text File  |  1992-05-24  |  9KB  |  162 lines
  1.         (****************************************************)
  2.         (* CSCALLS Ver 1.0    Written by Gary Bouchard      *)
  3.         (* SysOp - The Computer Store BBS                   *)
  4.         (* St. Augustine, Florida (904)794-0063             *)
  5.         (* Copyright(c) 1992....All Rights Reserved         *)
  6.         (* Released March 31, 1992  Modified                *)
  7.         (****************************************************)
  8.  
  9.                            Description
  10.  
  11. CSCALLS is a simple program that will generate a PCBoard 14.5a display
  12. file, showing the last group of callers to your system.
  13.  
  14. The number of callers shown in the display file is configurable, and can
  15. number up to 100. The sysop can define whether the program will add
  16. Local or SysOp logons to the list, the colors used by the program
  17. (using Pcboard @X## color macros), control of clearing the screen before
  18. display, and the name of the file that the program will generate.
  19.  
  20.                               Setup
  21.  
  22. Place CSCALLS.EXE anywhere in your DOS path, along with the
  23. configuration file. Edit your configuration file to reflect the
  24. locations and path names of the files needed for operation. These are
  25. as follows and should be in the exact order;
  26.  
  27. Line 1 is pretty simple.. you just define the name of the file you wish
  28. CSCALLS to generate. It can be any name allowed by DOS. For example, on
  29. my system, I generate a file called CSCALLS in my PCB\GEN directory.
  30. When the program runs it updates this file. At the bottom of my callers
  31. security level screen I place the line "%c:\pcb\gen\cscalls". After the
  32. security screen is displayed to the caller, the CSCALLS file is
  33. displayed. You can make it a bulletin, or attach it to your news file or
  34. whatever, by using the design of PCBoard 14.5a.
  35.  
  36. Line 2 defines a name and path for a temporary pcboard.sys file. This
  37. happens in two step. When a user logs onto PCBoard successfully, the
  38. information from the callers users record is put into the PCBOARD.SYS
  39. file. When the caller logs off, the file is still there, but is
  40. overwritten with filler, and since this program updates the CSCALLS file
  41. AFTER the user logs off, if we did not make a copy of the pcboard.sys
  42. file, we would not know who the caller was unless we went through the
  43. callers file...which is more trouble than its worth and slow. Using the
  44. method I have employed here, the information needed for the program is
  45. obtained in just a few lines of code, making it very fast.
  46.  
  47. On my system, I have created a batch file called $$LOGON.BAT. After
  48. successful logon, PCBoard checks to see if this file exists, and if so
  49. executes whatever is in it. What I did was very simply copy pcboard.sys
  50. to cscalls.sys from within the $$logon.bat file, then exit back to PCBoard,
  51. which is very quick. In this way, when user logs off, PCBoard also checks
  52. to see if there is a $$LOGOFF.BAT, and if so also executes that file.
  53. The $$logoff.bat file simply executes cscalls, and when its through,
  54. deletes the cscalls.sys we made at logon.
  55.  
  56. Line 3 is the path and name of your PCBoard users file. There is nothing
  57. written to this file. The program looks up the users record which
  58. PCBoard has already updated, and obtains more information about the
  59. caller.
  60.  
  61. Line 4 is the number of caller lines you would like the program to keep
  62. in the display file. In the example, this is set to 5. There is a maximum
  63. 100 lines.
  64.  
  65. Line 5 is the Security level cutoff. If anyone equals this security
  66. level or higher, they will not be included in the list.
  67.  
  68. Line 6-10 are user definable colors for the various pieces of the
  69. display file. Using the PCBoard @X## color macros allows just one
  70. version of the display file to be created, which can be display to both
  71. mono and color users.
  72.  
  73. Line 11 is the Shortened name of your BBS, which is incorporated into
  74. the display file.
  75.  
  76. Line 12 indicates whether or not you would like the @cls@ PCBoard macro
  77. added to the top of the display file. The program will only recognize
  78. the word CLEARSCREEN. Any other word found there will indicate that you
  79. do not want the screen cleared.
  80.  
  81. Line 13 is an option which will allow you to prevent SysOp logins from
  82. being added to the list. As long as you have a current, valid key file
  83. the program will honor this. If your key file is invalid or expired, you
  84. will not be able to override this.
  85.  
  86. Line 14 is an option to prevent LOCAL logins from being added to the
  87. list as with option 13. The same holds true in regard to the keyfile as
  88. option 13.
  89.  
  90. Line 15 specifies whether you prefer your list of callers to be sorted
  91. in ASending order or DSending order (I know it's speeled worng!). You
  92. must place one of the two on this line.
  93.  
  94. Look at the $$LOGON.BAT and $$LOGOFF.BAT. If you are not presently using
  95. these files in your PCBoard configuration, then just copy them to you
  96. PCBoard directory. If you are already using these files, then you need
  97. to add the lines contained in them to your existing files. The
  98. program will not operate properly without this information.
  99.  
  100.                             OPERATION
  101.           
  102. Each time the program runs it will first create a bakup of your existing
  103. display file in the directory specified by the original. The program
  104. will then open the cscalls.sys or whatever name you choose. I recommend
  105. following the naming conventions here so you can relate which files are
  106. used by which program. Opening the cscalls.sys file, the program will
  107. extract information about the caller and node. The program will then
  108. open the users file as specified in the cscalls.cnf, and extract the
  109. remaining information. Once the information is obtained about the
  110. caller, the program will determine if the user qualifies for the list.
  111. If it is disqualified say because of NOLOCAL or SECURITY or SYSOP or
  112. whatever, the program will then end. If the caller is ok, then the
  113. program will read in the prior list, add the new caller, and sort the
  114. list oldest call to newest call. If your maximum lines have been met,
  115. the program rotates the oldest caller line out, and moves everyone up
  116. one notch, otherwise, just keeps adding entries to the list.
  117.  
  118.                                DETAILS
  119.  
  120. CSCALLS is a copyrighted program. It is not Public Domain Software. I
  121. retain the rights to the source code for CSCALLS, and any modification,
  122. decompilation, or otherwise general hacking of CSCALLS is prohibited.
  123.  
  124. I cannot be held responsible for any damages caused by the use of this
  125. program. All know bugs have been squashed, but as with any new program,
  126. it has not been tested in every possible environment
  127.  
  128. There is no charge for CSCALLS. The program is being offered as
  129. FREEWARE to the thousands of PCBoard SysOps who are partially
  130. responsible for the BBS revolution. I am not a professional programmer, and
  131. I have a fulltime job (fortunately!). I program for a hobby, and write
  132. utilities for my personal PCBoard BBS. I share my utilities with other
  133. PCBoard SysOps, because I know of the hardships that can sometimes come
  134. about from running a BBS, including the many dollars put in to each
  135. system for the software and hardware needed to run a good system. SysOps
  136. like myself cannot afford to pay for all of the utilities authored by
  137. all of these people which make the job of running a BBS some much
  138. easier. There are many quality programs out there, that are well worth
  139. the small amount of money that is requested, but it all adds up, and
  140. fast! That is why I write FREEWARE programs..
  141.  
  142. You'll notice that there is a keyfile required for operation of this
  143. program. I have included in the ZIP a keyfile which will allow
  144. unhampered operation of this program for 1 year. To obtain a unlimited
  145. key file for this program, all you need to do is call my BBS, and let me
  146. know you would like a key file, and for which program.
  147. I will let you know how to obtain your free key file as soon as I see the
  148. message. If I am available when you call, I will direct you to that
  149. process right away.
  150.  
  151. As you might have noticed, I am not a good writer when it comes to
  152. documentation. If you do not understand something relating to this
  153. program please feel free to call my free access BBS at the phone number
  154. written at the top of this document. I will try to clarify whatever
  155. problem your having.
  156.  
  157.                            Acknowledgements
  158.  
  159. Portions of this program have been written with the aid of routines
  160. written by Samuel H. Smith of the ToolShop BBS (Prodoor), and B. Walter
  161. for his PCBUSERSYS functions.
  162.